/*-
 * MMS.java          TP-More-Messages-to-Send (TP-MMS)
 * 
 * $LastChangedBy: stein $
 * $LastChangedRevision: 95 $
 * $LastChangedDate: 2007-02-13 16:19:24 +0000 (Tue, 13 Feb 2007) $
 * $HeadURL: svn://localhost/SMS/src/com/googlecode/attention/sms/pdu/MMS.java $
 * 
 * Copyright (c) 2007, Stein Gunnar Bakkeby
 * All rights reserved.
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of Stein Gunnar Bakkeby nor the names of its
 *       contributors may be used to endorse or promote products derived
 *       from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS "AS IS" AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package com.googlecode.attention.sms.pdu;

import static com.googlecode.attention.util.bit.ByteBitValues.*;

/**
 * TP-More-Messages-to-Send (TP-MMS).
 * <BR>
 * The TP-More-Messages-to-Send is a 1-bit field, located within
 * bit no 2 of the first octet of SMS-DELIVER and SMS-STATUS-REPORT,
 * and to be given the following values:
 * <BR>
 * <BR>Bit no 2:
 * <BR><TABLE>
 * <TR><TD>0</TD><TD>More messages are waiting for the MS in this SC</TD></TR>
 * <TR><TD>1</TD><TD>No more messages are waiting for the MS in this SC</TD></TR>
 * </TABLE>
 * <BR>NOTE: In the case of SMS-STATUS-REPORT this parameter refers to
 * messages waiting for the mobile to which the status report is sent.
 * The term message in this context refers to SMS-messages or status reports.
 * 
 * @author Stein Gunnar Bakkeby
 */
public enum MMS {
  
  /** More messages are waiting for the MS in this SC. */
  MORE_MESSAGES_WAITING(0),
  /** No more messages are waiting for the MS in this SC */
  NO_MORE_MESSAGES_WAITING(B2);
  
  /** The binary value of the MMS. */
  public final int value;
  
  private MMS(final int value) {
    this.value = value;
  }
  
  /**
   * This will return the correct MMS enum based on the integer passed in.
   * 
   * @param value Can be bit 2 of the first octet, or the first octet itself.
   * @return The corresponding MMS enum
   */
  public static MMS parse(final int value) {
    switch (value & B2) { // filter value
    case 0:
      return MORE_MESSAGES_WAITING;
    case B2:
    default:
      return NO_MORE_MESSAGES_WAITING;
    }
  }
}